Basic usage - 基本用法
此系列文章的应用示例已发布于 GitHub: sequelize-docs-Zh-CN. 可以 Fork 帮助改进或 Star 关注更新. 欢迎 Star.
在开始之前，你首先必须创建一个 Sequelize 的实例。 像下面这样：
const sequelize = new Sequelize('database', 'username'[, 'password'])这将会保存要传递的数据库凭据并提供所有进一步的方法。此外，你还可以指定非默认的主机或端口：
const sequelize = new Sequelize('database', 'username', 'password', {
host: "my.server.tld",
port: 12345
})如果你没有密码：
const sequelize = new Sequelize('database', 'username')
// 或
const sequelize = new Sequelize('database', 'username', null)你也可以使用连接字符串：
const sequelize = new Sequelize('mysql://user:pass@example.com:9821/dbname', {
// 更多选项请看下一节
})选项
除了主机和端口，Sequelize 还提供了一大堆选项。它们在这:
const sequelize = new Sequelize('database', 'username', 'password', {
// 自定义主机; 默认值: localhost
host: 'my.server.tld',
// 自定义端口; 默认值: 3306
port: 12345,
// 自定义协议
// - 默认值: 'tcp'
// - 版本: v1.5.0
// - 仅限 postgres, 用于 heroku
protocol: null,
// 禁用日志; 默认值: console.log
logging: false,
// 数据库的 sql 方言
// - 当前支持: 'mysql', 'sqlite', 'postgres', 'mssql'
dialect: 'mysql',
// 你还可以将任何方言选项传递到底层方言库
// - 默认是空
// - 当前支持: 'mysql', 'postgres', 'mssql'
dialectOptions: {
socketPath: '/Applications/MAMP/tmp/mysql/mysql.sock',
supportBigNumbers: true,
bigNumberStrings: true
},
// sqlite 的存储引擎
// - 默认值 ':memory:'
storage: 'path/to/database.sqlite',
// 禁止将未定义的值插入为NULL
// - 默认值: false
omitNull: true,
// 是否使用本地库的标志
// 如果是 'pg' -- 设置为 true 将允许 SSL 支持
// - 默认值: false
native: true,
// 指定在调用 sequelize.define 时使用的选项
// 如下示例:
// define: {timestamps: false}
// 这基本等同于:
// sequelize.define(name, attributes, { timestamps: false })
// 没有必要像这样去设置每个定义的时间戳选项
// 下面你看到的这些可能设置的键. 本章中都进行了说明
define: {
underscored: false
freezeTableName: false,
syncOnAssociation: true,
charset: 'utf8',
dialectOptions: {
collate: 'utf8_general_ci'
},
timestamps: true
},
// 类似于同步：你可以定义始终强制同步模型
sync: { force: true },
// 每次关联后进行同步（见下文）。 如果设置为 false，则需要在设置所有关联后手动进行同步。 默认值: true
syncOnAssociation: true,
// 使用连接池来减少数据库连接超载并提高速度
// 当前仅支持 mysql 和 postgresql (从 v1.5.0 开始)
pool: { max: 5, idle: 30},
// 用于确定如何根据 [lingo project](https://github.com/visionmedia/lingo) 将单词翻译成单数形式或复数形式
// 选项为: en [默认], es
language: 'en',
// 每个事务的隔离级别. 默认是 REPEATABLE_READ
// 可用选项:
// READ_UNCOMMITTED
// READ_COMMITTED
// REPEATABLE_READ
// SERIALIZABLE
isolationLevel: Transaction.ISOLATION_LEVELS.REPEATABLE_READ
})提示: 你可以通过传递一个方法为日志部分设置一个自定义方法。第一个参数是将被记录的字符串 。
读取复制
Sequelize 支持读取复制，即在要执行 SELECT 查询时可以连接到多个服务器。 当你读取复制时，你指定一个或多个服务器作为读取副本，一个服务器充当写入主机，它处理所有写入和更新，并将其传播到副本（请注意，实际的复制进程为 不是 由 Sequelize 处理，而应该在 MySql 中设置）。
const sequelize = new Sequelize('database', null, null, {
dialect: 'mysql',
port: 3306
replication: {
read: [
{ host: '8.8.8.8', username: 'anotherusernamethanroot', password: 'lolcats!' },
{ host: 'localhost', username: 'root', password: null }
],
write: { host: 'localhost', username: 'root', password: null }
},
pool: { // 如果要覆盖用于读取池的选项，可以在此处进行
max: 20,
idle: 30000
},
})如果你有适用于所有副本的常规设置，则不需要为每个实例单独提供它们。在上面的代码中，数据库名称和端口被传播到所有副本。对于用户和密码也是如此， 如果你把它们用于任何一个副本。每个副本都有以下选项：host，port，username，password，database。
Sequelize 使用池来管理与副本的连接。 默认选项为：
{
max: 5,
min: 0,
idle: 10000,
acquire: 10000,
evict: 60000,
handleDisconnects: true
}如果要修改这些，可以在实例化 Sequelize 时作为选项传递池，如上所示。
注意: 读复制当前只适用于MySQL！
方言
随着 Sequelize 1.6.0 的发布，库可以独立于特定的方言。这意味着您必须自己添加相应的连接器库到您的项目。版本 1.7.0 stable 已经与连接器库（sequelize-mysql，sequelize-postgres等）捆绑在一起发布，但是这些软件包没有被维护，并且不会向2.0.0发布。
MySQL
为了使 Sequelize 与 MySQL 完美结合，您需要安装 mysql2@^1.0.0-rc.10 或更高版本。 一旦完成，你可以这样使用它：
const sequelize = new Sequelize('database', 'username', 'password', {
dialect: 'mysql'
})注意: 您可以通过设置 dialectOptions 参数将选项直接传递给方言库. 查看 Options
获取例子 (目前只支持mysql).
SQLite
对于 SQLite 兼容性，您将需要 sqlite3 @〜3.0.0。 配置 Sequelize 如下所示：
const sequelize = new Sequelize('database', 'username', 'password', {
// 设置成 sqlite
dialect: 'sqlite',
// sqlite 的存储引擎
// - default ':memory:'
storage: 'path/to/database.sqlite'
})或者您也可以使用连接字符串以及路径:
const sequelize = new Sequelize('sqlite:/home/abs/path/dbname.db')
const sequelize = new Sequelize('sqlite:relativePath/dbname.db')PostgreSQL
PostgreSQL 的库是 pg@^5.0.0 || ^6.0.0 || ^7.0.0 你只需要定义方言:
const sequelize = new Sequelize('database', 'username', 'password', {
// 定义为 postgres
dialect: 'postgres'
})MSSQL
MSSQL 的库是 tedious@^1.7.0 你只需要定义方言:
const sequelize = new Sequelize('database', 'username', 'password', {
dialect: 'mssql'
})执行原始 SQL 查询
由于常常使用简单的方式来执行原始/已经准备好的SQL查询，所以可以使用“sequelize.query”函数。
这是它如何工作的:
// 原始查询的参数
sequelize.query('your query', [, options])
// 简单的例子
sequelize.query("SELECT * FROM myTable").then(myTableRows => {
console.log(myTableRows)
})
// 如果要返回 sequelize 实例，请使用模型选项。
// 这样，你可以轻松地将查询映射到预定义的sequelize模型，例如：
sequelize
.query('SELECT * FROM projects', { model: Projects })
.then(projects => {
// 每个记录现在将映射到项目的模型。
console.log(projects)
})
// 选项是具有以下键的对象：
sequelize
.query('SELECT 1', {
// 用于记录查询的函数（或false）
// 每个发送到服务器的SQL查询都会调用
logging: console.log,
// 如果 plain 是 TRUE ，则 sequelize 将只返回结果集的第一条记录。
// 如果是 FALSE， 则是全部记录。
plain: false,
// 如果你没有查询的模型定义，请将其设置为true。
raw: false
})
// 注意第二个参数为null！
// 即使我们在这里声明一个被调用，raw: true 将取代并返回一个原始对象。
sequelize
.query('SELECT * FROM projects', { raw: true })
.then(projects => {
console.log(projects)
})查询中的替换可以通过两种不同的方式完成：
使用命名参数（以:开头），或者由未命名的
使用的语法取决于传递给函数的替换选项：
- 如果一个数组被传递，
?将按照它们在数组中出现的顺序被替换 - 如果传递一个对象，
:key将被该对象的键替换。如果包含在查询中的对象未找到对应的键，则会抛出异常，反之亦然。
sequelize
.query(
'SELECT * FROM projects WHERE status = ?',
{ raw: true, replacements: ['active']
)
.then(projects => {
console.log(projects)
})
sequelize
.query(
'SELECT * FROM projects WHERE status = :status ',
{ raw: true, replacements: { status: 'active' } }
)
.then(projects => {
console.log(projects)
})注意一点: 如果表的属性名称包含 " . "，则生成的对象将被嵌套：
sequelize.query('select 1 as `foo.bar.baz`').then(rows => {
console.log(JSON.stringify(rows))
/*
[{
"foo": {
"bar": {
"baz": 1
}
}
}]
*/
})如果这篇文章对您有帮助, 感谢 下方点赞 或 Star GitHub: sequelize-docs-Zh-CN 支持, 谢谢.
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用。你还可以使用@来通知其他用户。